home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Reference Guide / C-C++ Interactive Reference Guide.iso / c_ref / csource5 / 345_01 / tlchelp.doc < prev    next >
Text File  |  1989-07-11  |  6KB  |  122 lines
  1. /* -- remove this header before using file! --
  2. HEADER:        The Last Cross-Referencer;
  3. TITLE:        TLC/TLP - The Last Cross-Referencer;
  4. VERSION:    1.01;
  5.  
  6. DESCRIPTION: "TLC/TLP.
  7.             TLC Help documentation (put into shell's help file(s))";
  8.  
  9. KEYWORDS:    Utility, Cross-reference, C, Pascal, Apple, Macintosh, APW, Aztec;
  10. SYSTEM:        Macintosh MPW, v3.0;
  11. FILENAME:    TLCHELP.DOC;
  12. WARNINGS:    "Has not yet been ported to MS-DOS.
  13.             Shareware, $20 Check/Money Order suggested.";
  14.  
  15. SEE-ALSO:    README.TLC,TLPHELP.DOC;
  16. AUTHORS:    Eduard Schwan;
  17. COMPILERS:    AZTEC C65 v3.2b, APPLEIIGS APW C v1.0, APPLE MACINTOSH MPW C v3.0;
  18. */
  19.  
  20.  
  21. TLC v1.01 Release    * HELP *    Eduard Schwan Programs [ESP]
  22.  
  23. The Last C Cross-referencer (TLC) is a C language cross-referencer that
  24. reads one or more source files, and generates a source file listing (with
  25. line numbers) and a cross-reference list for the non-reserved symbols in
  26. the file(s).
  27. ------------------------------------------------------------------------------
  28. The reserved symbols are read from a text file (tlcresw.dat) during
  29. TLC initialization.  This file should contain only identifiers separated
  30. by spaces or newlines.    C-style comments are also allowed.  Any symbols
  31. put in this file will be treated as reserved words, and will not be cross-
  32. referenced;  And, if any symbols are removed (or commented out) from this
  33. file, they will be cross-referenced.  This allows tracking down the usage
  34. of certain reserved words (like enum or void, etc.)
  35. ------------------------------------------------------------------------------
  36. TLC usually gets the list of source files from the command line.  Sometimes,
  37. however, the list is quite long.  So TLC may be instructed to read a text
  38. file containing filenames (using the "-f filename" option).  This file must
  39. have one filename per line, with no leading or trailing blanks.  Blank lines
  40. and lines that begin with an asterisk ('*') in column 1 are ignored.
  41. ------------------------------------------------------------------------------
  42. TLC can be given additional instructions to tailor its operation and output
  43. by putting instructions into a 'parameter file'.  This is a text file, with
  44. parameter assignment statements in it.    The format is:
  45.     PARMNAME = numeric_value
  46.         or
  47.     PARMNAME = "String_Value"
  48. There may be multiple statements per line, but any statement must be fully
  49. contained on one line.    String values may have C-style embedded escape
  50. sequences in them.    An example of a valid string follows:
  51.     Printer_init = "\033N\x1b?" /* "<ESC>N<ESC>?" */
  52. Parameter names are case-insensitive, and any underscores may be omitted
  53. (e.g. "PRINTER_INIT" and "PrinterInit" are treated as the same.)
  54. The list of parameter names and their range of values is:
  55.  
  56. Parameter Name        Valid Range        Description
  57. --------------        ------------    ---------------------------------------
  58. DO_INCLUDES         0..1 num        1=Read includes in-line, 1=ignore includes
  59. DO_LISTING            0..1 num        1=Output the source listing, 0=Don't
  60. DO_XREF             0..1 num        1=Output the crossref listing, 0=Don't
  61. DO_STATS            0..1 num        1=Output the statistics listing, 0=Don't
  62. OUT_FNAME            1..40 string    Send output to this filename (default:tlc.out)
  63.  
  64. PAGE_LINES            10..255 num        total # of lines per page
  65. PAGE_COLUMNS        10..255 num        # of characters per line between <CR>s
  66. TOP_LINE            1..10 num        first line # of page to begin printing on
  67. BOT_LINE            10..255 num        last valid line # of page to print on
  68. LEFT_COLUMN         1..40 num        leftmost column to begin printing in (indent)
  69. RIGHT_COLUMN        10..255 num        rightmost valid column to print in
  70. USER_HEADING        1..80 string    user-defined heading used as 2nd heading line
  71. DO_SINGLE_SHTS*        0..1 num        1=Pause between pages, 0=continuous paper
  72. PRINTER_INIT        1..80 string    string to send to printer once to init. it
  73. HAS_FORM_FEED        0..1 num        1=send <FF> at end of page, 0=send n <CR><LF>s
  74. FIRST_PAGE            1..9999 num        1st page of listing/xref (starting page #)
  75. LAST_PAGE            1..9999 num        last page of listing/xref (ending page #)
  76.  
  77. EMPH1_LEADIN        1..9 string        string to send printer to start emph1
  78. EMPH2_LEADIN        1..9 string        string to send printer to start emph2
  79. EMPH3_LEADIN        1..9 string        string to send printer to start emph3
  80. EMPH1_LEADOUT        1..9 string        string to send printer to stop emph1
  81. EMPH2_LEADOUT        1..9 string        string to send printer to stop emph2
  82. EMPH3_LEADOUT        1..9 string        string to send printer to stop emph3
  83.  
  84. TAB_WIDTH            0..16 num        width of tabstops
  85. EMPH_COMMENTS*        0..3 num        Emphasize comments in source listing
  86. EMPH_HEADING*        0..3 num        Emphasize the page headings
  87. EMPH_RESERVED*        0..3 num        Emphasize reserved words in source listing
  88. EMPH_FUNCHEADS*        0..3 num        Emphasize func. headings in source listing
  89. PAGING_STRING        1..15 string    do new list page when this string encountered
  90.  
  91. SYMBOL_SIZE         1..32 num        # of significant characters in identifiers
  92. XREF_NUMS            0..1 num        Cross-reference and list all numbers
  93. XREF_STRINGS        0..1 num        Cross-reference and list all strings/chars
  94. DO_CONDITIONALS*     0..1 num        1=Evaluate & skip cond. code (#ifdef), 0=All
  95. DO_CASE_SENS        0..1 num        1=Make symbols case significant, 0=unsig.
  96. DO_XCASE_SENS*        0..1 num        1=Sort xref list case significant, 0=unsig.
  97. DO_UNDERSCORES        0..1 num        1=Make underscores significant, 0=Delete
  98. EMPH_SYMBOLS        0..3 num        Emphasize symbols in cross-reference list
  99.  
  100.     * = Not Implemented Yet
  101. ------------------------------------------------------------------------------
  102. To run The Last Cross-referencer, use the following command (parameters in
  103. square brackets [] are optional:
  104.  
  105. TLC [-f FnameListFile] [-p ParmFile] [-r ResWordFile] [-v] [-d] FileNames..
  106.  
  107. Where:
  108.     -d                    ........Turns on debug messages sent to stderr.
  109.     -f FnameListFile    ........Optional file containing list of source
  110.                                 file names to cross-reference.
  111.     -p ParmFile            ........Optional file containing parameters for
  112.                                 tailoring TLC output.
  113.     -r ResWordFile        ........Optional file containing reserved words
  114.                                 not to be cross-referenced.
  115.     -v                    ........Turns on progress messages sent to stderr.
  116.                                 Repeating this option (-v -v) gives even
  117.                                 more info.
  118.     FileName(s)            ........Source files to be cross-referenced.
  119.  
  120. Example:
  121.     TLC  -v  -r  myresw.dat  file1.h  file2.h  file1.c  file2.c
  122.